vcLineSet

vcLineSet is used for creating and reading line type geometry, which is a set of two or more points.

See in: Overview

Module: vcGeometry

Parent: vcGeometrySet

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
LineCountIntegerRGets the total number of lines in the set.
LineWidthRealRWGets or sets the width of each line in the set.
Lineslist[list[vcVector]]RGets a list of lines where each line is a list of position vectors for its points.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
addLineNoneList[vcVector] pointsCreates a new line set using a list of given points.
See more
Parameters:
points (list[vcVector]): List of points for the line.

Returns:
None
deleteLineNoneInteger lineIndexDeletes a line at a given index from the set.
See more
Parameters:
lineIndex (int): The index of the line to delete.

Exceptions:
IndexError: When an index is out of bounds.

Returns:
None
getLinelist[vcVector]Integer lineIndexGets a list of position vectors for each point of a line at a given index in set.
See more
Parameters:
lineIndex (int): The index of the line.

Exceptions:
IndexError: When an index is out of bounds.

Returns:
list[vcVector]: Line positions in a list.
getLinePointCountIntegerInteger lineIndexGets the number of points in a line at a given index in the set.
See more
Parameters:
lineIndex (int): The index of the line.

Exceptions:
IndexError: When an index is out of bounds.

Returns:
int: The number of points in the line.
updateNoneNoneUpdates the line set and its bounding box.